Test Action Type

The Test action type is used in Host-based command sequencing to wait for a specified period. The primary use of this action is to halt the process until the well test time has elapsed before processing the well test record. This is also useful in a variety of situations, such as waiting for the purge time to complete and testing if a point value changed to a desired value after a UIS command action.

The Test action type supports Conditional Actions and Steep Time Actions.

Condition Action

The Test action type also supports a series of conditional properties that can be used to interact with the primary test action. They represent the values of an expression and when the expression is true, the conditional actions defined will be executed. For example, specify an Exit action to exit the well test sequence. In the XML configuration these conditional actions are specified in the <ExitOnTagValueActions> element.

Notes:

The condition is evaluated every time the Sleep timer has elapsed
If the condition is true then the Test action will stop and the next action in the well test command sequence is executed
The condition actions are optional:
- If the condition is true and there are condition actions defined, those actions will execute and then move on to the next action in the well test command sequence
- If the condition is true and there aren’t any condition actions, CygNet simply moves on to the next action in the well test command sequence

Sleep Time Action

The Monitor or Test action types support the configuration of sleep time action(s) to specify how long the Test or Monitor action type will "sleep" before updating the actual timeout value and evaluating the conditional expression. If any actions are specified for the Sleep time actions, then for every sleeptime timeout specified, those actions will be executed. For example, wait five seconds and then poll the device. In the XML configuration these conditional actions are specified in the <SleepTimerActions> element.

Example

To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.

Example

</Action>

<Action type="PointValueCompare" operator="<>" value1="POMSV" value1type="UDC" value1relativeFacilityLink="Separator" value2="3" value2type="SELF" value2relativeFacilityLink="">

</TrueAction>

</Action>

</ExitOnTagValueActions>

</Action>

</Actions>

Test Action Type Attributes

The Test action type has the following associated configuration attributes:

Attribute	Required	Description
conditionRelativeFacilityLink	No	Specifies the relative facility tag to use for the conditional expression for this action. Note: The facility tag used as the starting point for the relative resolution depends on where this action type is configured. If the action is defined at a position level, then the base facility tag will be the well facility. If defined at the header level, the base facility will be the header facility.
operator	No	Specifies the operation used for the comparison. Acceptable values include: Equal — = (operator="=") Greater than — > (operator=">") Greater than or equal — >= (operator=">=") Less than — < (operator="<") Less than or equal — <= (operator="<=") Not equal — <> (operator="<>")
sleeptime	No	Specifies the time in milliseconds that the Monitor or Test action will "sleep" before updating the actual timeout value and evaluating the defined conditional actions. When the Sleep time timeout (sleeptime) expires, the actions defined in the Sleep Time Actions grid <SleepTimerActions> will be executed. For example, wait five seconds and then poll the device. See SleepTimerActions below.
timeouActualUdc	Yes	Specifies the actual UDC to use to post as a running count of how long the actions have been in the timeout. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.
timeoutRelativeFacilityLink	No	Specifies the relative facility tag to use for the action. E.g., Separator Note: The facility tag used as the starting point for the relative resolution depends on where this action type is configured. If the action is defined at a position level, then the base facility tag will be the well facility. If defined at the header level, the base facility will be the header facility.
timeoutValue	Yes	Specifies how the amount of time the test action will wait. Options include an actual value in seconds or a value from an associated point: if the Timeout Value type (timeoutValueType) is Self, then this value the amount of time the test action will wait. "0" indicates infinite amount of time. if the Timeout Value type (timeoutValueType) is UDC, then the value associated with the configured point will be used in the wait action.
timeoutValueType	Yes	Specifies the timeout value type. Values include Self or UDC.
timeoutValueUpdate	No	Indicates whether to update the actual timeout. Click the check box to enable the update. Options include True or False. If this value is set to True, then the point resolved in this action will be updated with the actual time spent waiting.
type	Yes	Specifies the action type for the action. E.g., type="Test"
udc	No	Specifies the actual UDC to use to post as a running count of how long the actions have been in the timeout. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.
value	No	Specifies the alphanumeric value to compare to the point value in the conditional expression.

ExitOnTagValueActions

Notes:

The condition is evaluated every time the Sleep timer has elapsed
If the condition is true then the Test action will stop and the next action in the well test command sequence is executed
The condition actions are optional:
- If the condition is true and there are condition actions defined, those actions will execute and then move on to the next action in the well test command sequence
- If the condition is true and there aren’t any condition actions, CygNet simply moves on to the next action in the well test command sequence

See the ExitOnTagValueActions element for more information.

SleepTimerActions

See the SleepTimerActions element for more information.